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.

Sign up for GitHub

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

Jump to bottom

fix some types in core #4912

Open
wants to merge 1 commit into
base: upload-progress-stale-file
Choose a base branch
from
+45 −44
Open

fix some types in core #4912

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
89 changes: 45 additions & 44 deletions packages/@uppy/core/src/Uppy.ts
View file
Open in desktop
Expand Up @@ -89,7 +89,7 @@ interface Plugins extends Record<string, Record<string, unknown> | undefined> {}

export interface State<M extends Meta, B extends Body>
extends Record<string, unknown> {
meta: M
meta: Partial<M>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is incorrect and whether it's Partial or not is up to the implementer of the generic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, so state is supposed to have all metadata from M (e.g. not partial)? then we need to either:

  • change UppyOptions so that it also takes in meta: M instead of meta: Partial<M>
  • or change this line

    uppy/packages/@uppy/core/src/Uppy.ts

    Line 388 in e4daea9

    meta: { ...this.opts.meta },
    so that it somehow sets default values for all M keys, but I don't know how to do that because M is not known

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so state is supposed to have all metadata from M

Yes that's correct

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've now tried to update the meta types to M instead of Partial<M> but TS is failing because we are trying to assign this.opts.meta to Partial<M> ({}) here:

uppy/packages/@uppy/core/src/Uppy.ts

Line 352 in e4daea9

meta: opts?.meta ?? {},

I think it would be a breaking change to alter this behavior

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can do this as a type meta: M | undefined. Which is different from making all properties optional.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that would help because {} is not assignable to M | undefined. or do you mean changing the runtime behavior to:

meta: opts?.meta

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if i do that i get

M could be instantiated with an arbitrary type which could be unrelated to M | undefined .

capabilities: {
uploadProgress: boolean
individualCancellation: boolean
Expand Down Expand Up @@ -124,15 +124,15 @@ export interface UppyOptions<M extends Meta, B extends Body> {
logger?: typeof debugLogger
debug?: boolean
restrictions: Restrictions
meta?: M
meta?: Partial<M>
onBeforeFileAdded?: (
currentFile: UppyFile<M, B>,
files: { [key: string]: UppyFile<M, B> },
) => UppyFile<M, B> | boolean | undefined
onBeforeUpload?: (files: {
[key: string]: UppyFile<M, B>
}) => { [key: string]: UppyFile<M, B> } | boolean
locale?: Locale
locale?: OptionalPluralizeLocale
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure about this? defaultLocale is indeed OptionalPluralizeLocale but I don't think this is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're getting typescript errors if it's set to Locale

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That might be but this option should be Locale.

// TODO: add <State<M, B>> when landing on `4.x`
store?: DefaultStore
infoTimeout?: number
Expand All @@ -154,9 +154,12 @@ type MinimalRequiredOptions<M extends Meta, B extends Body> = Partial<
}
>

export type NonNullableUppyOptions<M extends Meta, B extends Body> = Required<
UppyOptions<M, B>
>
// everything is required, except for `locale`
export type NonNullableUppyOptions<M extends Meta, B extends Body> = Omit<
Required<UppyOptions<M, B>>,
'locale'
> &
Pick<UppyOptions<M, B>, 'locale'>
Murderlon marked this conversation as resolved.
Show resolved Hide resolved

type GenericEventCallback = () => void
type FileAddedCallback<M extends Meta, B extends Body> = (
Expand Down Expand Up @@ -309,7 +312,7 @@ export class Uppy<M extends Meta, B extends Body> {

#postProcessors: Set<Processor> = new Set()

defaultLocale: Locale
defaultLocale: OptionalPluralizeLocale

locale: Locale

Expand All @@ -331,34 +334,29 @@ export class Uppy<M extends Meta, B extends Body> {
* Instantiate Uppy
*/
constructor(opts?: UppyOptionsWithOptionalRestrictions<M, B>) {
this.defaultLocale = locale as any as Locale

const defaultOptions: UppyOptions<Record<string, unknown>, B> = {
id: 'uppy',
autoProceed: false,
allowMultipleUploadBatches: true,
debug: false,
restrictions: defaultRestrictionOptions,
meta: {},
onBeforeFileAdded: (file, files) => !Object.hasOwn(files, file.id),
onBeforeUpload: (files) => files,
store: new DefaultStore(),
logger: justErrorsLogger,
infoTimeout: 5000,
}

const merged = { ...defaultOptions, ...opts } as Omit<
NonNullableUppyOptions<M, B>,
'restrictions'
>
this.defaultLocale = locale

// Merge default options with the ones set by user,
// making sure to merge restrictions too
this.opts = {
...merged,
...opts,
id: opts?.id ?? 'uppy',
autoProceed: opts?.autoProceed ?? false,
allowMultipleUploadBatches: opts?.allowMultipleUploadBatches ?? true,
allowMultipleUploads: opts?.allowMultipleUploads ?? true,
debug: opts?.debug ?? false,
// making sure to merge restrictions too:
restrictions: {
...(defaultOptions.restrictions as Restrictions),
...(opts && opts.restrictions),
...defaultRestrictionOptions,
...opts?.restrictions,
},
meta: opts?.meta ?? {},
onBeforeFileAdded:
opts?.onBeforeFileAdded ??
((file, files) => !Object.hasOwn(files, file.id)),
onBeforeUpload: opts?.onBeforeUpload ?? ((files) => files),
store: opts?.store ?? new DefaultStore(),
logger: opts?.logger ?? justErrorsLogger,
infoTimeout: opts?.infoTimeout ?? 5000,
}

// Support debug: true for backwards-compatability, unless logger is set in opts
Expand Down Expand Up @@ -543,10 +541,10 @@ export class Uppy<M extends Meta, B extends Body> {
setOptions(newOpts: MinimalRequiredOptions<M, B>): void {
this.opts = {
...this.opts,
...(newOpts as UppyOptions<M, B>),
...newOpts,
restrictions: {
...this.opts.restrictions,
...(newOpts?.restrictions as Restrictions),
...newOpts?.restrictions,
},
}

Expand Down Expand Up @@ -855,7 +853,7 @@ export class Uppy<M extends Meta, B extends Body> {
size: fileDescriptorOrFile.size,
data: fileDescriptorOrFile,
}
: fileDescriptorOrFile) as UppyFile<M, B>
: fileDescriptorOrFile) as UppyFile<M, B> // todo remove this `as` (it hides a lot of logical issues)

const fileType = getFileType(file)
const fileName = getFileName(fileType, file)
Expand Down Expand Up @@ -1016,10 +1014,10 @@ export class Uppy<M extends Meta, B extends Body> {
* and start an upload if `autoProceed === true`.
*/
addFile(file: File | MinimalRequiredUppyFile<M, B>): UppyFile<M, B>['id'] {
this.#assertNewUploadAllowed(file as UppyFile<M, B>)
this.#assertNewUploadAllowed(file as UppyFile<M, B>) // todo remove this `as` (it hides a lot of logical issues)

const { nextFilesState, validFilesToAdd, errors } =
this.#checkAndUpdateFileState([file as UppyFile<M, B>])
this.#checkAndUpdateFileState([file as UppyFile<M, B>]) // todo remove this `as` (it hides a lot of logical issues)

const restrictionErrors = errors.filter((error) => error.isRestriction)
this.#informAndEmit(restrictionErrors)
Expand Down Expand Up @@ -1052,6 +1050,7 @@ export class Uppy<M extends Meta, B extends Body> {
this.#assertNewUploadAllowed()

const { nextFilesState, validFilesToAdd, errors } =
// todo remove this `as` (it hides a lot of logical issues)
this.#checkAndUpdateFileState(fileDescriptors as UppyFile<M, B>[])

const restrictionErrors = errors.filter((error) => error.isRestriction)
Expand Down Expand Up @@ -1391,23 +1390,25 @@ export class Uppy<M extends Meta, B extends Body> {

if (sizedFiles.length === 0) {
const progressMax = inProgress.length * 100
const currentProgress = unsizedFiles.reduce((acc, file) => {
return acc + (file.progress.percentage as number)
}, 0)
const currentProgress = unsizedFiles.reduce(
(acc, file) => acc + (file.progress.percentage ?? 0),
0,
)
const totalProgress = Math.round((currentProgress / progressMax) * 100)
this.setState({ totalProgress })
return
}

let totalSize = sizedFiles.reduce((acc, file) => {
return (acc + (file.progress.bytesTotal ?? 0)) as number
}, 0)
let totalSize = sizedFiles.reduce(
(acc, file) => acc + (file.progress.bytesTotal ?? 0),
0,
)
const averageSize = totalSize / sizedFiles.length
totalSize += averageSize * unsizedFiles.length

let uploadedSize = 0
sizedFiles.forEach((file) => {
uploadedSize += file.progress.bytesUploaded as number
uploadedSize += Number(file.progress.bytesUploaded)
})
unsizedFiles.forEach((file) => {
uploadedSize += (averageSize * (file.progress.percentage || 0)) / 100
Expand Down Expand Up @@ -1512,7 +1513,7 @@ export class Uppy<M extends Meta, B extends Body> {
percentage: 0,
bytesUploaded: 0,
bytesTotal: file.size,
} as FileProgressStarted,
} satisfies FileProgressStarted,
},
]),
)
Expand Down