Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: only process function if runtime is node #196

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions src/Serverless.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
declare namespace Serverless {

interface Instance {
cli: {
log(str: string): void
Expand All @@ -8,17 +9,7 @@ declare namespace Serverless {
servicePath: string
}

service: {
provider: {
name: string
}
functions: {
[key: string]: Serverless.Function
}
package: Serverless.Package
getAllFunctions(): string[]
}

service: Service
pluginManager: PluginManager
}

Expand All @@ -31,6 +22,7 @@ declare namespace Serverless {
interface Function {
handler: string
package: Serverless.Package
runtime?: string
}

interface Package {
Expand All @@ -40,6 +32,18 @@ declare namespace Serverless {
individually?: boolean
}

type FunctionMap = Record<string, Serverless.Function>

interface Service {
provider: {
name: string
runtime?: string
}
functions: FunctionMap
package: Serverless.Package
getAllFunctions(): string[]
}

interface PluginManager {
spawn(command: string): Promise<void>
}
Expand Down
23 changes: 13 additions & 10 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import * as path from 'path'
import * as fs from 'fs-extra'
import * as _ from 'lodash'
import * as globby from 'globby'
import globby from 'globby'

import * as typescript from './typescript'
import { watchFiles } from './watchFiles'

const SERVERLESS_FOLDER = '.serverless'
const BUILD_FOLDER = '.build'

export class TypeScriptPlugin {
class TypeScriptPlugin {
private originalServicePath: string
private isWatching: boolean

Expand Down Expand Up @@ -79,13 +79,16 @@ export class TypeScriptPlugin {
const { options } = this
const { service } = this.serverless

if (options.function) {
return {
[options.function]: service.functions[this.options.function]
}
}
const allFunctions = options.function ? {
[options.function]: service.functions[this.options.function]
} : service.functions

return service.functions
// Ensure we only handle runtimes that support Typescript
return _.pickBy(allFunctions, ({runtime}) => {
const resolvedRuntime = runtime || service.provider.runtime
// If runtime is not specified on the function or provider, default to previous behaviour
return resolvedRuntime === undefined ? true : resolvedRuntime.match(/^node/)
})
}

get rootFileNames() {
Expand Down Expand Up @@ -234,7 +237,7 @@ export class TypeScriptPlugin {
}

if (service.package.individually) {
const functionNames = service.getAllFunctions()
const functionNames = Object.keys(this.functions)
functionNames.forEach(name => {
service.functions[name].package.artifact = path.join(
this.originalServicePath,
Expand Down Expand Up @@ -275,4 +278,4 @@ export class TypeScriptPlugin {
}
}

module.exports = TypeScriptPlugin
export = TypeScriptPlugin
110 changes: 110 additions & 0 deletions tests/index.functions.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import TypeScriptPlugin from '../src'

const createInstance = (functions: Serverless.FunctionMap, globalRuntime?: string): Serverless.Instance => ({
cli: {
log: jest.fn()
},
config: {
servicePath: 'servicePath'
},
service: {
provider: {
name: 'aws',
runtime: globalRuntime
},
package: {
individually: true,
include: [],
exclude: []
},
functions,
getAllFunctions: jest.fn()
},
pluginManager: {
spawn: jest.fn()
}
})

describe('functions', () => {
const functions: Serverless.FunctionMap = {
hello: {
handler: 'tests/assets/hello.handler',
package: {
include: [],
exclude: []
}
},
world: {
handler: 'tests/assets/world.handler',
runtime: 'nodejs12.x',
package: {
include: [],
exclude: []
},
},
js: {
handler: 'tests/assets/jsfile.create',
package: {
include: [],
exclude: []
}
},
notActuallyTypescript: {
handler: 'tests/assets/jsfile.create',
package: {
include: [],
exclude: []
},
runtime: 'go1.x'
},
}

describe('when the provider runtime is Node', () => {
it('can get filter out non node based functions', () => {
const slsInstance = createInstance(functions, 'nodejs10.x')
const plugin = new TypeScriptPlugin(slsInstance, {})

expect(
Object.values(plugin.functions).map(fn => fn.handler),
).toEqual(
[
'tests/assets/hello.handler',
'tests/assets/world.handler',
'tests/assets/jsfile.create',
],
)
})
})

describe('when the provider runtime is not Node', () => {
it('can get filter out non node based functions', () => {
const slsInstance = createInstance(functions, 'python2.7')
const plugin = new TypeScriptPlugin(slsInstance, {})

expect(
Object.values(plugin.functions).map(fn => fn.handler),
).toEqual(
[
'tests/assets/world.handler',
],
)
})
})

describe('when the provider runtime is undefined', () => {
it('can get filter out non node based functions', () => {
const slsInstance = createInstance(functions)
const plugin = new TypeScriptPlugin(slsInstance, {})

expect(
Object.values(plugin.functions).map(fn => fn.handler),
).toEqual(
[
'tests/assets/hello.handler',
'tests/assets/world.handler',
'tests/assets/jsfile.create',
],
)
})
})
})
50 changes: 0 additions & 50 deletions tests/typescript.extractFileName.test.ts

This file was deleted.

3 changes: 2 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"rootDir": ".",
"target": "es6",
"sourceMap": true,
"outDir": "dist"
"outDir": "dist",
"esModuleInterop": true
},
"exclude": [
"node_modules"
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3456,9 +3456,9 @@ type-check@~0.3.2:
prelude-ls "~1.1.2"

typescript@^3.4.1:
version "3.4.1"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.4.1.tgz#b6691be11a881ffa9a05765a205cb7383f3b63c6"
integrity sha512-3NSMb2VzDQm8oBTLH6Nj55VVtUEpe/rgkIzMir0qVoLyjDZlnMBva0U6vDiV3IH+sl/Yu6oP5QwsAQtHPmDd2Q==
version "3.7.5"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.5.tgz#0692e21f65fd4108b9330238aac11dd2e177a1ae"
integrity sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==

uglify-js@^3.1.4:
version "3.5.2"
Expand Down