Skip to content

[package:mime] Choose default extension based on external source. #2063

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lrhn
Copy link
Member

@lrhn lrhn commented Apr 7, 2025

For consideration, proof-of-concept using Android default extensions.

The Debian and Apache mime.types are not trying to assign a preferred extension to mime types. They are interpreting existing extensions to guess the content's media type, or passing along existing files with existing extensions, not creating new files with new extensions.

If there is a good source for the preferred extension for a media type, then we should use that.

There might be media types that are so wide-spanning that no single extension can cover all of them correctly. Like the application/x-msdownload media type which the Apache web server associates with .exe, .msi, .dll, .com and .bat (not not .cmd).
Those extensions are not interchangable,
and using the wrong one would be incorrect.
Such a mime type should possibly not have a
default/preferred extension.

Proof-of-concept using Android default extensions.

The Debian and Apache mime.types are not trying to assign a
*preferred* extension to mime types. They are interpreting
existing extensions to guess the content's media type,
or passing along existing files with existing extensions,
not creating new files with new extensions.

If there is a good source for the preferred extension
for a media type, then we should use that.

There might be media types that are so wide-spanning
that no single extension can cover all of them correctly.
Like the `application/x-msdownload` media type which
the Apache web server associates with `.exe`, `.msi`,
`.dll`, `.com` and `.bat` (not not `.cmd`).
Those extensions are not interchangable,
and using the wrong one would be incorrect.
Such a mime type should possibly *not* have a
default/preferred extension.
@lrhn
Copy link
Member Author

lrhn commented Apr 7, 2025

@devoncarew

We seem to have issues with choosing the default extension. Not sure where to find a credible and complete source of truth, though.

Copy link

github-actions bot commented Apr 7, 2025

Package publishing

Package Version Status Publish tag (post-merge)
package:bazel_worker 1.1.3 already published at pub.dev
package:benchmark_harness 2.3.1 already published at pub.dev
package:boolean_selector 2.1.2 already published at pub.dev
package:browser_launcher 1.1.3 already published at pub.dev
package:cli_config 0.2.1-wip WIP (no publish necessary)
package:cli_util 0.4.2 already published at pub.dev
package:clock 1.1.2 already published at pub.dev
package:code_builder 4.10.1 already published at pub.dev
package:coverage 1.12.0-wip WIP (no publish necessary)
package:csslib 1.0.2 already published at pub.dev
package:extension_discovery 2.1.0 already published at pub.dev
package:file 7.0.2-wip WIP (no publish necessary)
package:file_testing 3.1.0-wip WIP (no publish necessary)
package:glob 2.1.3 already published at pub.dev
package:graphs 2.3.3-wip WIP (no publish necessary)
package:html 0.15.5+1 ready to publish html-v0.15.5+1
package:io 1.1.0-wip WIP (no publish necessary)
package:json_rpc_2 3.0.3 already published at pub.dev
package:markdown 7.3.1-wip WIP (no publish necessary)
package:mime 2.0.0 already published at pub.dev
package:oauth2 2.0.4-wip WIP (no publish necessary)
package:package_config 2.3.0-wip WIP (no publish necessary)
package:pool 1.5.2-wip WIP (no publish necessary)
package:pub_semver 2.2.0 already published at pub.dev
package:pubspec_parse 1.5.0 already published at pub.dev
package:source_map_stack_trace 2.1.3-wip WIP (no publish necessary)
package:source_maps 0.10.14-wip WIP (no publish necessary)
package:source_span 1.10.1 already published at pub.dev
package:sse 4.1.7 already published at pub.dev
package:stack_trace 1.12.1 already published at pub.dev
package:stream_channel 2.1.4 already published at pub.dev
package:stream_transform 2.1.2-wip WIP (no publish necessary)
package:string_scanner 1.4.1 already published at pub.dev
package:term_glyph 1.2.3-wip WIP (no publish necessary)
package:test_reflective_loader 0.2.3 already published at pub.dev
package:timing 1.0.2 already published at pub.dev
package:unified_analytics 7.0.2 already published at pub.dev
package:watcher 1.1.1 already published at pub.dev
package:yaml 3.1.3 already published at pub.dev
package:yaml_edit 2.2.2 already published at pub.dev

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

Copy link

github-actions bot commented Apr 7, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
mime None 2.0.0 2.0.0 2.0.0 ✔️
Changelog Entry
Package Changed Files
package:mime pkgs/mime/lib/src/extension.dart

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

Coverage ⚠️
File Coverage
pkgs/mime/lib/src/extension.dart 💚 100 %
pkgs/mime/tool/generate_defaults.dart 💔 Not covered

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/bazel_worker/benchmark/benchmark.dart
pkgs/bazel_worker/example/client.dart
pkgs/bazel_worker/example/worker.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/coverage/lib/src/coverage_options.dart
pkgs/coverage/test/collect_coverage_config_test.dart
pkgs/coverage/test/config_file_locator_test.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

Expects a file to be placed in /third_party/preferred_extension.mime.types.
(Or pointed to on command line).
@devoncarew
Copy link
Member

For consideration, proof-of-concept using Android default extensions.

You're thinking of separating the source-of-truth for ext=>mime from mime=>preferred extension? I think that would be fine, as we're having trouble finding a canonical source that contains both.

Heads up that I discarded the android source for general media mappings as it's never undated (no process, and only done a few times in the last few years, w/ some reverted). Tracking apache for media mappings seems generally better.

I'm not sure how important being able to get the default ext for a given media type is (what's the use case?). So just using this libraries current defaults, choosing the first in the list of supported extensions, and allowing people to contribute new preferred defaults, seems reasonable.

@lrhn
Copy link
Member Author

lrhn commented Apr 8, 2025

One use case could be receiving a file over HTTP and wanting to save it locally with a meaningful extension.
Until file systems start allowing files to have media types, that'll keep being useful.

We have open issues for changing the default extension for, fx, mp3, so someone is using it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants