Skip to content

Commit f68bd3f

Browse files
zwu52Feiyang1
zwu52
and
Feiyang1
authored
Create FM CDN build (#4264)
* Create FM CDN build (sw) * Refactor Build Rules * revert index.cdn.ts for firebase-exp/app auto formatting tool did its work but since this is not part of this PR reverting it. * Use subdir modules instead of file name pattern * Remove uncessray rules for sw subdir * Update based on review * Remove sw es5 builds * Update packages-exp/firebase-exp/rollup.config.release.js Co-authored-by: Feiyang <[email protected]> * Apply suggestions from code review Co-authored-by: Feiyang <[email protected]> * Update packages-exp/messaging-exp/sw/package.json Co-authored-by: Feiyang <[email protected]> * fix various issues (#4316) * Disabling non-functional fis stubbing Co-authored-by: Feiyang <[email protected]>
1 parent fb90580 commit f68bd3f

File tree

13 files changed

+184
-46
lines changed

13 files changed

+184
-46
lines changed

‎packages-exp/firebase-exp/messaging/index.sw.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* @license
3+
* Copyright 2020 Google LLC
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
export { onBackgroundMessage, getMessaging } from '@firebase/messaging-exp/sw';

‎packages-exp/firebase-exp/messaging/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@
1414
* See the License for the specific language governing permissions and
1515
* limitations under the License.
1616
*/
17+
1718
export * from '@firebase/messaging-exp';

‎packages-exp/firebase-exp/rollup.config.js

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@
1515
* limitations under the License.
1616
*/
1717

18+
import appPkg from './app/package.json';
19+
import commonjs from '@rollup/plugin-commonjs';
20+
import json from '@rollup/plugin-json';
21+
import pkg from './package.json';
1822
import { resolve } from 'path';
1923
import resolveModule from '@rollup/plugin-node-resolve';
20-
import commonjs from '@rollup/plugin-commonjs';
21-
import sourcemaps from 'rollup-plugin-sourcemaps';
2224
import rollupTypescriptPlugin from 'rollup-plugin-typescript2';
25+
import sourcemaps from 'rollup-plugin-sourcemaps';
2326
import typescript from 'typescript';
2427
import { uglify } from 'rollup-plugin-uglify';
25-
import json from '@rollup/plugin-json';
26-
import pkg from './package.json';
27-
import appPkg from './app/package.json';
2828

2929
const external = Object.keys(pkg.dependencies || {});
3030

@@ -129,6 +129,47 @@ const componentBuilds = pkg.components
129129
// It is needed for handling sub modules, for example firestore/lite which should produce firebase-firestore-lite.js
130130
// Otherwise, we will create a directory with '/' in the name.
131131
const componentName = component.replace('/', '-');
132+
133+
if (component === 'messaging') {
134+
return [
135+
{
136+
input: `${component}/index.ts`,
137+
output: [
138+
{
139+
file: resolve(component, pkg.main),
140+
format: 'cjs',
141+
sourcemap: true
142+
},
143+
{
144+
file: resolve(component, pkg.module),
145+
format: 'es',
146+
sourcemap: true
147+
}
148+
],
149+
plugins: [...plugins, typescriptPlugin],
150+
external
151+
},
152+
{
153+
input: `${component}/index.ts`,
154+
output: createUmdOutputConfig(
155+
`firebase-${componentName}.js`,
156+
componentName
157+
),
158+
plugins: [...plugins, typescriptPluginUMD, uglify()],
159+
external: ['@firebase/app-exp']
160+
},
161+
{
162+
input: `${component}/index.sw.ts`,
163+
output: createUmdOutputConfig(
164+
`firebase-${componentName}-sw.js`,
165+
componentName
166+
),
167+
plugins: [...plugins, typescriptPluginUMD, uglify()],
168+
external: ['@firebase/app-exp']
169+
}
170+
];
171+
}
172+
132173
return [
133174
{
134175
input: `${component}/index.ts`,

‎packages-exp/firebase-exp/rollup.config.release.js

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@
1515
* limitations under the License.
1616
*/
1717

18+
import alias from '@rollup/plugin-alias';
19+
import appPkg from './app/package.json';
20+
import commonjs from '@rollup/plugin-commonjs';
21+
import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path';
22+
import json from '@rollup/plugin-json';
23+
import pkg from './package.json';
1824
import { resolve } from 'path';
1925
import resolveModule from '@rollup/plugin-node-resolve';
20-
import commonjs from '@rollup/plugin-commonjs';
21-
import sourcemaps from 'rollup-plugin-sourcemaps';
2226
import rollupTypescriptPlugin from 'rollup-plugin-typescript2';
23-
import alias from '@rollup/plugin-alias';
27+
import sourcemaps from 'rollup-plugin-sourcemaps';
2428
import typescript from 'typescript';
2529
import { uglify } from 'rollup-plugin-uglify';
26-
import json from '@rollup/plugin-json';
27-
import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path';
28-
import pkg from './package.json';
29-
import appPkg from './app/package.json';
3030

3131
// remove -exp from dependencies name
3232
const deps = Object.keys(pkg.dependencies || {}).map(name =>
@@ -125,6 +125,76 @@ const componentBuilds = pkg.components
125125
// It is needed for handling sub modules, for example firestore/lite which should produce firebase-firestore-lite.js
126126
// Otherwise, we will create a directory with '/' in the name.
127127
const componentName = component.replace('/', '-');
128+
129+
if (component === 'messaging') {
130+
return [
131+
{
132+
input: `${component}/index.ts`,
133+
output: [
134+
{
135+
file: resolve(component, pkg.main),
136+
format: 'cjs',
137+
sourcemap: true
138+
},
139+
{
140+
file: resolve(component, pkg.module),
141+
format: 'es',
142+
sourcemap: true
143+
}
144+
],
145+
plugins: [...plugins, typescriptPlugin],
146+
external: id =>
147+
deps.some(dep => id === dep || id.startsWith(`${dep}/`))
148+
},
149+
{
150+
input: `${component}/index.ts`,
151+
output: createUmdOutputConfig(
152+
`firebase-${componentName}.js`,
153+
componentName
154+
),
155+
plugins: [
156+
...plugins,
157+
typescriptPluginUMD,
158+
/**
159+
* Hack to bundle @firebase/installations-exp
160+
*/
161+
alias({
162+
entries: [
163+
{
164+
find: '@firebase/installations',
165+
replacement: '@firebase/installations-exp'
166+
}
167+
]
168+
})
169+
],
170+
external: ['@firebase/app']
171+
},
172+
{
173+
input: `${component}/index.sw.ts`,
174+
output: createUmdOutputConfig(
175+
`firebase-${componentName}-sw.js`,
176+
componentName
177+
),
178+
plugins: [
179+
...plugins,
180+
typescriptPluginUMD,
181+
/**
182+
* Hack to bundle @firebase/installations-exp
183+
*/
184+
alias({
185+
entries: [
186+
{
187+
find: '@firebase/installations',
188+
replacement: '@firebase/installations-exp'
189+
}
190+
]
191+
})
192+
],
193+
external: ['@firebase/app']
194+
}
195+
];
196+
}
197+
128198
return [
129199
{
130200
input: `${component}/index.ts`,

‎packages-exp/messaging-exp/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"main": "dist/index.cjs.js",
88
"module": "dist/index.esm.js",
99
"esm2017": "dist/index.esm2017.js",
10-
"sw": "dist/index.sw.esm5.js",
10+
"typings": "dist/index.d.ts",
11+
"sw": "dist/index.sw.esm2017.js",
1112
"files": [
1213
"dist"
1314
],
@@ -52,6 +53,5 @@
5253
},
5354
"bugs": {
5455
"url": "https://github.com/firebase/firebase-js-sdk/issues"
55-
},
56-
"typings": "dist/index.d.ts"
57-
}
56+
}
57+
}

‎packages-exp/messaging-exp/rollup.config.js

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ const es5BuildPlugins = [
3535
];
3636

3737
const es5Builds = [
38-
// window builds
3938
{
4039
input: 'src/index.ts',
4140
output: [
@@ -44,14 +43,6 @@ const es5Builds = [
4443
],
4544
plugins: es5BuildPlugins,
4645
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
47-
},
48-
49-
// sw builds
50-
{
51-
input: 'src/index.sw.ts',
52-
output: [{ file: pkg.sw, format: 'es', sourcemap: true }],
53-
plugins: es5BuildPlugins,
54-
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
5546
}
5647
];
5748

@@ -80,6 +71,14 @@ const es2017Builds = [
8071
},
8172
plugins: es2017BuildPlugins,
8273
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
74+
},
75+
76+
// sw builds
77+
{
78+
input: 'src/index.sw.ts',
79+
output: { file: pkg.sw, format: 'es', sourcemap: true },
80+
plugins: es5BuildPlugins,
81+
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
8382
}
8483
];
8584

‎packages-exp/messaging-exp/rollup.config.release.js

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ const es5BuildPlugins = [
3939
];
4040

4141
const es5Builds = [
42-
// window builds
4342
{
4443
input: 'src/index.ts',
4544
output: [
@@ -48,17 +47,9 @@ const es5Builds = [
4847
],
4948
plugins: es5BuildPlugins,
5049
treeshake: {
51-
moduleSideEffects: false
50+
moduleSideEffects: (id, external) => id === '@firebase/installations'
5251
},
5352
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
54-
},
55-
56-
// sw builds
57-
{
58-
input: 'src/index.sw.ts',
59-
output: [{ file: pkg.sw, format: 'es', sourcemap: true }],
60-
plugins: es5BuildPlugins,
61-
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
6253
}
6354
];
6455

@@ -90,9 +81,20 @@ const es2017Builds = [
9081
},
9182
plugins: es2017BuildPlugins,
9283
treeshake: {
93-
moduleSideEffects: false
84+
moduleSideEffects: (id, external) => id === '@firebase/installations'
9485
},
9586
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
87+
},
88+
89+
// sw builds
90+
{
91+
input: 'src/index.sw.ts',
92+
output: { file: pkg.sw, format: 'es', sourcemap: true },
93+
plugins: es5BuildPlugins,
94+
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
95+
treeshake: {
96+
moduleSideEffects: (id, external) => id === '@firebase/installations'
97+
}
9698
}
9799
];
98100

‎packages-exp/messaging-exp/src/api/onBackgroundMessage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export function onBackgroundMessage(
2626
messaging: MessagingService,
2727
nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>
2828
): Unsubscribe {
29-
if (!!navigator) {
29+
if (self.document !== undefined) {
3030
throw ERROR_FACTORY.create(ErrorCode.AVAILABLE_IN_SW);
3131
}
3232

‎packages-exp/messaging-exp/src/index.sw.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import { FirebaseMessaging } from '@firebase/messaging-types-exp';
1919
import { registerMessaging } from './helpers/register';
20+
import '@firebase/installations-exp';
2021

2122
export { onBackgroundMessage, getMessaging } from './api';
2223

‎packages-exp/messaging-exp/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import { FirebaseMessaging } from '@firebase/messaging-types-exp';
1919
import { registerMessaging } from './helpers/register';
20+
import '@firebase/installations-exp';
2021

2122
export { getToken, deleteToken, onMessage, getMessaging } from './api';
2223

‎packages-exp/messaging-exp/src/internals/requests.test.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717

1818
import '../testing/setup';
1919

20-
import * as installationsModule from '@firebase/installations-exp';
21-
2220
import {
2321
ApiRequestBody,
2422
requestDeleteToken,
@@ -40,15 +38,11 @@ describe('API', () => {
4038
let tokenDetails: TokenDetails;
4139
let firebaseDependencies: FirebaseInternalDependencies;
4240
let fetchStub: Stub<typeof fetch>;
43-
let getAuthTokenStub: Stub<typeof installationsModule['getToken']>;
4441

4542
beforeEach(() => {
4643
tokenDetails = getFakeTokenDetails();
4744
firebaseDependencies = getFakeFirebaseDependencies();
4845
fetchStub = stub(self, 'fetch');
49-
getAuthTokenStub = stub(installationsModule, 'getToken').resolves(
50-
'authToken'
51-
);
5246
});
5347

5448
describe('getToken', () => {
@@ -85,7 +79,7 @@ describe('API', () => {
8579

8680
expect(response).to.equal('fcm-token-from-server');
8781
expect(fetchStub).to.be.calledOnceWith(expectedEndpoint, expectedRequest);
88-
expect(getAuthTokenStub).to.be.called;
82+
// TODO: expect fis.getToken to be called. There is some issue w/ stubbing the fis module.
8983
const actualHeaders = fetchStub.lastCall.lastArg.headers;
9084
compareHeaders(expectedHeaders, actualHeaders);
9185
});

‎packages-exp/messaging-exp/src/internals/requests.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import { SubscriptionOptions, TokenDetails } from '../interfaces/token-details';
2121

2222
import { AppConfig } from '../interfaces/app-config';
2323
import { FirebaseInternalDependencies } from '../interfaces/internal-dependencies';
24-
import { getToken } from '@firebase/installations-exp';
2524

2625
export interface ApiResponse {
2726
token?: string;
@@ -155,7 +154,7 @@ async function getHeaders({
155154
appConfig,
156155
installations
157156
}: FirebaseInternalDependencies): Promise<Headers> {
158-
const authToken = await getToken(installations);
157+
const authToken = await installations.getToken();
159158

160159
return new Headers({
161160
'Content-Type': 'application/json',

‎packages-exp/messaging-exp/sw/package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"name": "@firebase/messaging-exp",
3+
"private": true,
4+
"version": "0.0.900",
5+
"description": "",
6+
"author": "Firebase <[email protected]> (https://firebase.google.com/)",
7+
"module": "../dist/index.sw.esm2017.js",
8+
"typings": "../dist/index.sw.d.ts",
9+
"files": [
10+
"dist"
11+
]
12+
}

0 commit comments

Comments
 (0)