hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-10 19:43:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into w2p-50632_Replace-mock-registry-service-with-implementation

Browse Source
This commit is contained in:
Kristof De Langhe
2018-05-03 11:41:48 +02:00
parent bac69f8b2f c19369f027
commit cfe4066b9e
12 changed files with 60 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -239,6 +239,7 @@ dspace-angular
├── config * Folder for configuration files ├── config * Folder for configuration files
│   ├── environment.default.js * Default configuration files │   ├── environment.default.js * Default configuration files
│   └── environment.test.js * Test configuration files │   └── environment.test.js * Test configuration files
├── docs * Folder for documentation
├── e2e * Folder for e2e test files ├── e2e * Folder for e2e test files
│   ├── app.e2e-spec.ts * │   ├── app.e2e-spec.ts *
│   ├── app.po.ts * │   ├── app.po.ts *
@@ -380,6 +381,11 @@ This project makes use of [`yarn`](https://yarnpkg.com/en/) to ensure that the e
As you can see above, using `yarn` commandline tools means that you should never need to modify the `package.json` manually. *We recommend always using `yarn` to keep dependencies updated / in sync.* As you can see above, using `yarn` commandline tools means that you should never need to modify the `package.json` manually. *We recommend always using `yarn` to keep dependencies updated / in sync.*
Further Documentation
---------------------
See [`./docs`](docs) for further documentation.
Frequently asked questions Frequently asked questions
-------------------------- --------------------------

2
config/environment.default.js
View File

@@ -28,6 +28,8 @@ module.exports = {
async: true, async: true,
time: false time: false
}, },
// Google Analytics tracking id
gaTrackingId: '',
// Log directory // Log directory
logDirectory: '.', logDirectory: '.',
// NOTE: will log all redux actions and transfers in console // NOTE: will log all redux actions and transfers in console

10
docs/Configuration.md Normal file
View File

@@ -0,0 +1,10 @@
# Configuration
## Supporting analytics services other than Google Analytics
This project makes use of [Angulartics](https://angulartics.github.io/angulartics2/) to track usage events and send them to Google Analytics.
Angulartics can be configured to work with a number of other services besides Google Analytics as well, e.g. [Piwik](https://github.com/angulartics/angulartics2/tree/master/src/lib/providers/piwik), [Google Tag Manager](https://github.com/angulartics/angulartics2/tree/master/src/lib/providers/gtm), or [Azure Application Insights](https://azure.microsoft.com/en-us/services/application-insights/) to name a few.
In order to start using one of these services, select it from the [Angulartics Providers page](https://angulartics.github.io/angulartics2/#providers), and follow the instructions on how to configure it.
The Google Analytics script was added in [`main.browser.ts`](https://github.com/DSpace/dspace-angular/blob/ff04760f4af91ac3e7add5e7424a46cb2439e874/src/main.browser.ts#L33) instead of the `<head>` tag in `index.html` to ensure events get sent when the page is shown in a client's browser, and not when it's rendered on the universal server. Likely you'll want to do the same when adding a new service.

1
package.json
View File

@@ -87,6 +87,7 @@
"@ngx-translate/core": "9.1.1", "@ngx-translate/core": "9.1.1",
"@ngx-translate/http-loader": "2.0.1", "@ngx-translate/http-loader": "2.0.1",
"angular-idle-preload": "2.0.4", "angular-idle-preload": "2.0.4",
"angulartics2": "^5.2.0",
"body-parser": "1.18.2", "body-parser": "1.18.2",
"bootstrap": "^4.0.0", "bootstrap": "^4.0.0",
"cerialize": "0.1.18", "cerialize": "0.1.18",

3
src/app/app.component.spec.ts
View File

@@ -30,6 +30,8 @@ import { NativeWindowRef, NativeWindowService } from './shared/window.service';
import { MockTranslateLoader } from './shared/mocks/mock-translate-loader'; import { MockTranslateLoader } from './shared/mocks/mock-translate-loader';
import { MockMetadataService } from './shared/mocks/mock-metadata-service'; import { MockMetadataService } from './shared/mocks/mock-metadata-service';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { AngularticsMock } from './shared/mocks/mock-angulartics.service';
let comp: AppComponent; let comp: AppComponent;
let fixture: ComponentFixture<AppComponent>; let fixture: ComponentFixture<AppComponent>;
@@ -56,6 +58,7 @@ describe('App component', () => {
{ provide: GLOBAL_CONFIG, useValue: ENV_CONFIG }, { provide: GLOBAL_CONFIG, useValue: ENV_CONFIG },
{ provide: NativeWindowService, useValue: new NativeWindowRef() }, { provide: NativeWindowService, useValue: new NativeWindowRef() },
{ provide: MetadataService, useValue: new MockMetadataService() }, { provide: MetadataService, useValue: new MockMetadataService() },
{ provide: Angulartics2GoogleAnalytics, useValue: new AngularticsMock() },
AppComponent AppComponent
], ],
schemas: [CUSTOM_ELEMENTS_SCHEMA] schemas: [CUSTOM_ELEMENTS_SCHEMA]

4
src/app/app.component.ts
View File

@@ -17,6 +17,7 @@ import { MetadataService } from './core/metadata/metadata.service';
import { HostWindowResizeAction } from './shared/host-window.actions'; import { HostWindowResizeAction } from './shared/host-window.actions';
import { HostWindowState } from './shared/host-window.reducer'; import { HostWindowState } from './shared/host-window.reducer';
import { NativeWindowRef, NativeWindowService } from './shared/window.service'; import { NativeWindowRef, NativeWindowService } from './shared/window.service';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
@Component({ @Component({
selector: 'ds-app', selector: 'ds-app',
@@ -32,7 +33,8 @@ export class AppComponent implements OnInit {
@Inject(NativeWindowService) private _window: NativeWindowRef, @Inject(NativeWindowService) private _window: NativeWindowRef,
private translate: TranslateService, private translate: TranslateService,
private store: Store<HostWindowState>, private store: Store<HostWindowState>,
private metadata: MetadataService private metadata: MetadataService,
private angulartics2GoogleAnalytics: Angulartics2GoogleAnalytics
) { ) {
// this language will be used as a fallback when a translation isn't found in the current language // this language will be used as a fallback when a translation isn't found in the current language
translate.setDefaultLang('en'); translate.setDefaultLang('en');

4
src/app/shared/mocks/mock-angulartics.service.ts Normal file
View File

@@ -0,0 +1,4 @@
/* tslint:disable:no-empty */
export class AngularticsMock {
public eventTrack(action, properties) { }
}

1
src/config/global-config.interface.ts
View File

@@ -9,6 +9,7 @@ export interface GlobalConfig extends Config {
production: boolean; production: boolean;
cache: CacheConfig; cache: CacheConfig;
universal: UniversalConfig; universal: UniversalConfig;
gaTrackingId: string;
logDirectory: string; logDirectory: string;
debug: boolean; debug: boolean;
} }

18
src/main.browser.ts
View File

@@ -6,7 +6,7 @@ import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { bootloader } from '@angularclass/bootloader'; import { bootloader } from '@angularclass/bootloader';
import { load as loadWebFont } from 'webfontloader'; import { load as loadWebFont } from 'webfontloader';
import { hasValue } from './app/shared/empty.util'; import { hasValue, isNotEmpty } from './app/shared/empty.util';
import { BrowserAppModule } from './modules/app/browser-app.module'; import { BrowserAppModule } from './modules/app/browser-app.module';
@@ -25,9 +25,25 @@ export function main() {
} }
}); });
addGoogleAnalytics();
return platformBrowserDynamic().bootstrapModule(BrowserAppModule); return platformBrowserDynamic().bootstrapModule(BrowserAppModule);
} }
function addGoogleAnalytics() {
// Add google analytics if key is present in config
const trackingId = ENV_CONFIG.gaTrackingId;
if (isNotEmpty(trackingId)) {
const keyScript = document.createElement('script');
keyScript.innerHTML = `(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');`
+ 'ga(\'create\', \'' + ENV_CONFIG.gaTrackingId + '\', \'auto\');';
document.body.appendChild(keyScript);
}
}
// support async tag or hmr // support async tag or hmr
if (hasValue(ENV_CONFIG.universal) && ENV_CONFIG.universal.preboot === false) { if (hasValue(ENV_CONFIG.universal) && ENV_CONFIG.universal.preboot === false) {
bootloader(main); bootloader(main);

3
src/modules/app/browser-app.module.ts
View File

@@ -14,6 +14,8 @@ import { AppComponent } from '../../app/app.component';
import { AppModule } from '../../app/app.module'; import { AppModule } from '../../app/app.module';
import { DSpaceBrowserTransferStateModule } from '../transfer-state/dspace-browser-transfer-state.module'; import { DSpaceBrowserTransferStateModule } from '../transfer-state/dspace-browser-transfer-state.module';
import { DSpaceTransferState } from '../transfer-state/dspace-transfer-state.service'; import { DSpaceTransferState } from '../transfer-state/dspace-transfer-state.service';
import { Angulartics2Module } from 'angulartics2';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
export function createTranslateLoader(http: HttpClient) { export function createTranslateLoader(http: HttpClient) {
return new TranslateHttpLoader(http, 'assets/i18n/', '.json'); return new TranslateHttpLoader(http, 'assets/i18n/', '.json');
@@ -34,6 +36,7 @@ export function createTranslateLoader(http: HttpClient) {
preloadingStrategy: preloadingStrategy:
IdlePreload IdlePreload
}), }),
Angulartics2Module.forRoot([Angulartics2GoogleAnalytics]),
BrowserAnimationsModule, BrowserAnimationsModule,
DSpaceBrowserTransferStateModule, DSpaceBrowserTransferStateModule,
TranslateModule.forRoot({ TranslateModule.forRoot({

4
src/modules/app/server-app.module.ts
View File

@@ -16,6 +16,9 @@ import { DSpaceTransferState } from '../transfer-state/dspace-transfer-state.ser
import { TranslateUniversalLoader } from '../translate-universal-loader'; import { TranslateUniversalLoader } from '../translate-universal-loader';
import { Angulartics2GoogleAnalytics } from 'angulartics2/ga';
import { AngularticsMock } from '../../app/shared/mocks/mock-angulartics.service';
export function createTranslateLoader() { export function createTranslateLoader() {
return new TranslateUniversalLoader('dist/assets/i18n/', '.json'); return new TranslateUniversalLoader('dist/assets/i18n/', '.json');
} }
@@ -42,6 +45,7 @@ export function createTranslateLoader() {
AppModule AppModule
], ],
providers: [ providers: [
{ provide: Angulartics2GoogleAnalytics, useClass: AngularticsMock }
] ]
}) })
export class ServerAppModule { export class ServerAppModule {

6
yarn.lock
View File

@@ -427,6 +427,12 @@ angular2-template-loader@0.6.2:
dependencies: dependencies:
loader-utils "^0.2.15" loader-utils "^0.2.15"
angulartics2@^5.2.0:
version "5.2.0"
resolved "https://registry.yarnpkg.com/angulartics2/-/angulartics2-5.2.0.tgz#5bac82d4b6acf798b7db906488861e70b49fe04c"
dependencies:
tslib "^1.7.1"
ansi-align@^2.0.0: ansi-align@^2.0.0:
version "2.0.0" version "2.0.0"
resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-2.0.0.tgz#c36aeccba563b89ceb556f3690f0b1d9e3547f7f" resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-2.0.0.tgz#c36aeccba563b89ceb556f3690f0b1d9e3547f7f"